home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 4 / Apprentice-Release4.iso / Languages / MPW Oberon 2.1168 / OInterfaces / ErrMgr.mod < prev    next >
Encoding:
Text File  |  1995-08-07  |  3.4 KB  |  88 lines  |  [TEXT/MPS ]
  1. (*
  2.     File:        ErrMgr.mod
  3.  
  4.     Copyright:    © 1987-88, 1993-95 by Apple Computer, Inc.
  5.                 All rights reserved.
  6.  
  7.     Version:    3.4a4
  8.     Created:    Tuesday, March 30, 1993 18:00
  9.  
  10. *)
  11.  
  12. (*$TAGS-*)
  13. (*$CALLING PASCAL*)
  14. MODULE ErrMgr;
  15.  
  16. IMPORT SYSTEM, Types;
  17.  
  18.  
  19. PROCEDURE InitErrMgr*(toolErrFilename: Types.Str255;sysErrFilename: Types.Str255;showToolErrNbrs: BOOLEAN);
  20.     EXTERNAL PASCAL;
  21. (* ErrMgr initialization.This must be done before using any other ErrMgr
  22. routine.  Set showToolErrNbrs to true if you want all tool messages to contain
  23. the error number following the message text enclosed in parentheses (e.g.,
  24. "<msg txt> ([OS] Error <n>)"; system error messages always contain the error
  25. number).  The toolErrFileName parameter is used to specify the name of a
  26. tool-specific error file, and should be the NULL or a null string if not used
  27. (or if the tool's data fork is to be used as the error file, see
  28. GetToolErrText for futher details). The sysErrFileName parameter is used to
  29. specify the name of a system error file, and should normally be the NULL or a
  30. null string, which causes the ErrMgr to look in the MPW Shell directory for
  31. "SysErrs.Err" (see GetSysErrText). *)
  32.  
  33.  
  34. PROCEDURE CloseErrMgr*;
  35.     EXTERNAL (*•• C*);
  36. (* Ideally a CloseErrMgr should be done at the end of execution to make sure all
  37. files opened by the ErrMgr are closed.    You can let normal program termination
  38. do the closing.  But if you are a purist...
  39.  *)
  40.  
  41.  
  42. PROCEDURE GetSysErrText*(msgNbr: INTEGER;errMsg: Types.StringPtr);
  43.     EXTERNAL PASCAL;
  44. (* Get the error message text corresponding to system error number errNbr from
  45. the system error message file (whose name was specified in the InitErrMgr
  46. call).    The text of the message is returned in errMsg and the function returns
  47. a pointer to errMsg.  The maximum length of the message is limited to 254
  48. characters.
  49.  
  50. Note, if a system message filename was not specified to InitErrMgr, then the
  51. ErrMgr assumes the message file contained in the file "SysErrs.Err".  This
  52. file is first accessed as "                                 (*ShellDirectory*)SysErrs.Err" on the assumption that
  53. SysErrs.Err is kept in the same directory as the MPW Shell.  If the file
  54. cannot be opened, then an open is attempted on "SysErrs.Err" in the System
  55. Folder. *)
  56.  
  57.  
  58. PROCEDURE AddErrInsert*(insert: Types.Str255;msgString: Types.StringPtr);
  59.     EXTERNAL (*•• C*);
  60. (* Add another insert to an error message string.This call is used when more
  61. than one insert is to be added to a message (because it contains more than
  62. one 'POINTER TO ' character).
  63.  *)
  64.  
  65.  
  66. PROCEDURE GetToolErrText*(msgNbr: INTEGER;errInsert: Types.Str255;errMsg: Types.StringPtr);
  67.     EXTERNAL PASCAL;
  68. (* Get the error message text corresponding to tool error number errNbr from
  69. the tool error message file (whose name was specified in the InitErrMgr
  70. call).    The text of the message is returned in errMsg and the function returns
  71. a pointer to errMsg.  The maximum length of the message is limited to 254
  72. characters.  If the message is to have an insert, then ErrInsert should be a
  73. pointer to it.    Otherwise it should be either be a null string or a NULL
  74. pointer.
  75.  
  76. Inserts are indicated in error messages by specifying a 'POINTER TO ' to indicate where
  77. the insert is to be placed.
  78.  
  79. Note, if a tool message filename was not specified to InitErrMgr, then the
  80. ErrMgr assumes the message file contained in the data fork of the tool calling
  81. the ErrMgr.  This name is contained in the Shell variable    (*Command*) and the
  82. value of that variable is used to open the error message file. *)
  83.  
  84.  
  85.  
  86.     END ErrMgr.
  87.  
  88.